@openai/agents-core/dist/errors.d.ts

The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.

import { Agent, AgentOutputType } from './agent';
import { InputGuardrailResult, OutputGuardrailMetadata, OutputGuardrailResult } from './guardrail';
import { RunState } from './runState';
import { TextOutput } from './types';
/**
 * Base class for all errors thrown by the library.
 */
export declare abstract class AgentsError extends Error {
    state?: RunState<any, Agent<any, any>>;
    constructor(message: string, state?: RunState<any, Agent<any, any>>);
}
/**
 * System error thrown when the library encounters an error that is not caused by the user's
 * misconfiguration.
 */
export declare class SystemError extends AgentsError {
}
/**
 * Error thrown when the maximum number of turns is exceeded.
 */
export declare class MaxTurnsExceededError extends AgentsError {
}
/**
 * Error thrown when a model behavior is unexpected.
 */
export declare class ModelBehaviorError extends AgentsError {
}
/**
 * Error thrown when the error is caused by the library user's misconfiguration.
 */
export declare class UserError extends AgentsError {
}
/**
 * Error thrown when a guardrail execution fails.
 */
export declare class GuardrailExecutionError extends AgentsError {
    error: Error;
    constructor(message: string, error: Error, state?: RunState<any, Agent<any, any>>);
}
/**
 * Error thrown when a tool call fails.
 */
export declare class ToolCallError extends AgentsError {
    error: Error;
    constructor(message: string, error: Error, state?: RunState<any, Agent<any, any>>);
}
/**
 * Error thrown when an input guardrail tripwire is triggered.
 */
export declare class InputGuardrailTripwireTriggered extends AgentsError {
    result: InputGuardrailResult;
    constructor(message: string, result: InputGuardrailResult, state?: RunState<any, any>);
}
/**
 * Error thrown when an output guardrail tripwire is triggered.
 */
export declare class OutputGuardrailTripwireTriggered<TMeta extends OutputGuardrailMetadata, TOutputType extends AgentOutputType = TextOutput> extends AgentsError {
    result: OutputGuardrailResult<TMeta, TOutputType>;
    constructor(message: string, result: OutputGuardrailResult<TMeta, TOutputType>, state?: RunState<any, any>);
}