Skip to main content

PromptError

Enum PromptError 

Source
#[non_exhaustive]
pub enum PromptError { Provider(ProviderError), Report(ErrorReport), Memory(MemoryError), MaxTurns { max_turns: usize, chat_history: Vec<Message>, prompt: Message, }, Cancelled { chat_history: Vec<Message>, reason: String, }, UnknownToolCall { tool_name: String, available_tools: Vec<String>, allowed_tools: Vec<String>, chat_history: Vec<Message>, }, }
Expand description

Why an agent run failed, whether it was awaited or streamed.

Variants that wrap another error display it unchanged and forward its source.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Provider(ProviderError)

A provider completion failed.

§

Report(ErrorReport)

Structured effect failure from the bus, a handler, a hook, or a stream item. A provider failure relayed over the bus arrives as its report.

§

Memory(MemoryError)

Conversation memory failed to load or persist history.

§

MaxTurns

The run exhausted its total model-call budget.

Fields

§max_turns: usize

Configured total model-call budget.

§chat_history: Vec<Message>

Canonical history available when the budget was exhausted.

§prompt: Message

Prompt for the call that could not be dispatched.

§

Cancelled

The run was cancelled.

Fields

§chat_history: Vec<Message>

Canonical history available at cancellation.

§reason: String

Human-readable cancellation reason.

§

UnknownToolCall

The model attempted to call a tool unavailable for the current turn.

Fields

§tool_name: String

Tool name emitted by the model.

§available_tools: Vec<String>

Tools registered on the runtime.

§allowed_tools: Vec<String>

Exact immutable set allowed for this turn.

§chat_history: Vec<Message>

Canonical history available at failure.

Implementations§

Source§

impl PromptError

Source

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

Returns the provider response body exposed by a wrapped completion error.

Source

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

Parses the provider response body of a wrapped completion error as JSON when present.

Source

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

Returns the provider transport request id exposed by a wrapped completion error, or carried by a wire report.

Source

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

Returns the HTTP status exposed by a wrapped completion error, or carried by a wire report.

Source

pub fn provider_response_headers(&self) -> Option<&HeaderMap>

Returns the response headers exposed by a wrapped completion error or report.

Source§

impl PromptError

Source

pub fn cancelled( chat_history: impl IntoIterator<Item = Message>, reason: impl Into<String>, ) -> Self

Build a PromptError::Cancelled from the history available at cancellation and a reason.

Trait Implementations§

Source§

impl Debug for PromptError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PromptError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for PromptError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<ErrorReport> for PromptError

Source§

fn from(source: ErrorReport) -> Self

Converts to this type from the input type.
Source§

impl From<MemoryError> for PromptError

Source§

fn from(source: MemoryError) -> Self

Converts to this type from the input type.
Source§

impl From<PromptError> for StreamToStdoutError

Source§

fn from(source: PromptError) -> Self

Converts to this type from the input type.
Source§

impl From<PromptError> for StructuredOutputError

Source§

fn from(source: PromptError) -> Self

Converts to this type from the input type.
Source§

impl From<PromptError> for ScenarioError

Available on crate feature test-utils only.
Source§

fn from(source: PromptError) -> Self

Converts to this type from the input type.
Source§

impl From<ProviderError> for PromptError

A failure relayed over the bus is the report the origin sent.

Source§

fn from(error: ProviderError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more