Class: AiError

Thrown by ctx.ai for a model request that has no answer (AiFailureKind): an AppError whose retryable and retryAfterMs are the host's, so an action that lets it go fails as the vendor did (a 429 or a 5xx retryable, after the wait it asked for; a refusal or an answer outside its schema final).

Extends

• AppError

Constructors

Constructor

new AiError(message, details): AiError;

Parameters

message

string

details

AiErrorDetails

Returns

AiError

Overrides

AppError.constructor

Properties

cause?

optional cause?: unknown;

Inherited from

AppError.cause

---

kind

readonly kind: AiFailureKind;

---

message

message: string;

Inherited from

AppError.message

---

name

name: string;

Inherited from

AppError.name

---

options

readonly options: AppErrorOptions = {};

Inherited from

AppError.options

---

questionIds

readonly questionIds: string[] | undefined;

---

stack?

optional stack?: string;

Inherited from

AppError.stack

---

status

readonly status: number | undefined;

---

usage

readonly usage: AiUsage | undefined;

---

stackTraceLimit

static stackTraceLimit: number;

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

AppError.stackTraceLimit

Accessors

retryable

Get Signature

get retryable(): boolean;

Returns

boolean

---

retryAfterMs

Get Signature

get retryAfterMs(): number | undefined;

Returns

number | undefined

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

AppError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

AppError.prepareStackTrace