About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class AiModelException

Exception thrown when an AI model request fails. Wraps provider-specific HTTP errors with structured information about the failure, including the model name, HTTP status code, and any error detail extracted from the provider's response.

Since

2.5

Hierarchy (View Summary)

Exception
- AiModelException

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'AI'

HttpStatusCode IsRetryable ModelName ProviderErrorMessage

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Exception.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Exception.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Exception.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Exception.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from Exception.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Exception.Equals

Extended capability 'AI'

HttpStatusCode

get HttpStatusCode(): HttpStatusCode | null
Gets the HTTP status code returned by the AI model provider, or null if no HTTP response was received.

Returns HttpStatusCode | null
Since
2.5

IsRetryable

get IsRetryable(): boolean
Gets a value indicating whether the error is transient and may succeed if retried. Examples of retryable errors include rate limiting (429) and server errors (5xx).

Returns boolean
Since
2.5

ModelName

get ModelName(): string
Gets the name of the AI model that produced the error.

Returns string
Since
2.5

ProviderErrorMessage

get ProviderErrorMessage(): string | null
Gets the error detail extracted from the provider's response body, or null if none was available.

Returns string | null
Since
2.5