Enum PromptError 

pub enum PromptError {
    CompletionError(CompletionError),
    ToolError(ToolSetError),
    ToolServerError(Box<ToolServerError>),
    MaxTurnsError {
        max_turns: usize,
        chat_history: Box<Vec<Message>>,
        prompt: Box<Message>,
    },
    PromptCancelled {
        chat_history: Vec<Message>,
        reason: String,
    },
    UnknownToolCall {
        tool_name: String,
        available_tools: Vec<String>,
        allowed_tools: Vec<String>,
        chat_history: Box<Vec<Message>>,
    },
}

Errors from agent prompting.

When the failure wraps CompletionError, Self::provider_response_body, Self::provider_response_json, and Self::provider_response_status forward to the inner completion error’s helpers.

Variants

CompletionError(CompletionError)

Something went wrong with the completion

ToolError(ToolSetError)

There was an error while using a tool

ToolServerError(Box<ToolServerError>)

There was an issue while executing a tool on a tool server

MaxTurnsError

The run exhausted its total model-call budget. The budget includes the initial call and every retry or continuation; increase .max_turns() if the intended interaction requires more calls.

Fields

max_turns: usize

chat_history: Box<Vec<Message>>

prompt: Box<Message>

PromptCancelled

A prompting loop was cancelled.

Fields

chat_history: Vec<Message>

reason: String

UnknownToolCall

The model emitted a structured tool call for a tool Rig did not allow for the current turn.

Fields

tool_name: String

available_tools: Vec<String>

allowed_tools: Vec<String>

chat_history: Box<Vec<Message>>

Implementations

impl PromptError

pub fn provider_response_body(&self) -> Option<&str>

Returns the provider response body when this wraps a completion error that exposes one.

pub fn provider_response_json(&self) -> Result<Option<Value>, Error>

Parses the provider response body as JSON when available through a wrapped completion error.

Returns:

• Ok(Some(value)) when a body is present and valid JSON.
• Ok(None) when no provider response body is available.
• Err(error) when a body is present but isn’t valid JSON.

pub fn provider_response_status(&self) -> Option<StatusCode>

Returns the HTTP status when this wraps a completion error that preserves one, including from non-success HTTP responses and 2xx error envelopes.

Trait Implementations

impl Debug for PromptError

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

Formats the value using the given formatter.

impl Display for PromptError

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

Formats the value using the given formatter.

impl Error for PromptError

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<Box<PromptError>> for StreamingError

fn from(source: Box<PromptError>) -> Self

Converts to this type from the input type.

impl From<Box<PromptError>> for StructuredOutputError

fn from(source: Box<PromptError>) -> Self

Converts to this type from the input type.

impl From<Box<ToolServerError>> for PromptError

fn from(source: Box<ToolServerError>) -> Self

Converts to this type from the input type.

impl From<CompletionError> for PromptError

fn from(source: CompletionError) -> Self

Converts to this type from the input type.

impl From<MemoryError> for PromptError

Surface crate::memory::ConversationMemory failures through the existing CompletionError::RequestError variant so adding memory support does not require a new top-level PromptError arm in downstream exhaustive matchers.

fn from(err: MemoryError) -> Self

Converts to this type from the input type.

impl From<ToolSetError> for PromptError

fn from(source: ToolSetError) -> Self

Converts to this type from the input type.