Enum AgentsError 

pub enum AgentsError {
    OpenAIError(OpenAIError),
    MaxTurnsExceeded {
        max_turns: usize,
    },
    InputGuardrailTriggered {
        message: String,
    },
    OutputGuardrailTriggered {
        message: String,
    },
    ToolExecutionError {
        message: String,
    },
    HandoffError {
        message: String,
    },
    ModelBehaviorError {
        message: String,
    },
    UserError {
        message: String,
    },
    SessionError(String),
    SerializationError(Error),
    IoError(Error),
    DatabaseError(Error),
    Other(String),
}

The main error enum for the Agents SDK.

AgentsError consolidates all possible errors that can occur within the SDK into a single, comprehensive type. This allows for robust and centralized error handling.

Variants

OpenAIError(OpenAIError)

An error originating from the underlying async-openai crate.

MaxTurnsExceeded

Indicates that the maximum number of turns for an agent run has been exceeded, preventing infinite loops.

Fields

max_turns: usize

InputGuardrailTriggered

An input guardrail was triggered, indicating that the user’s input violated a predefined constraint.

Fields

message: String

OutputGuardrailTriggered

An output guardrail was triggered, indicating that the agent’s response violated a predefined constraint.

Fields

message: String

ToolExecutionError

An error occurred during the execution of a tool.

Fields

message: String

HandoffError

An error occurred during a handoff between agents.

Fields

message: String

ModelBehaviorError

An error indicating unexpected or invalid behavior from the LLM.

Fields

message: String

UserError

An error caused by invalid user input or configuration.

Fields

message: String

SessionError(String)

An error related to session management, such as a failure to read or write to the session store.

SerializationError(Error)

An error that occurred during JSON serialization or deserialization.

IoError(Error)

An I/O error, typically related to file system operations.

DatabaseError(Error)

An error from the database, used by persistent session stores.

Other(String)

A catch-all for any other type of error.

Trait Implementations

impl Debug for AgentsError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for AgentsError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for AgentsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for AgentsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AgentsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AgentsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<OpenAIError> for AgentsError

fn from(source: OpenAIError) -> Self

Converts to this type from the input type.