Skip to main content

Class: ProviderBatchError

Defined in: packages/core/src/errors.ts:42

Thrown when a model call sent through a provider batch endpoint gets no usable result.

status is the reason: the provider reported the request failed, cancelled or expired; the request was missing from a completed batch's results; the whole batch could not be started or finished (batch-failed); or the call cannot be batched and fallback: 'error' forbade a live call (unsupported). batch is the provider batch reference when one exists — the same { version: 2, id, provider } shape AI SDK's experimental_getBatchResults accepts — so a caller can recover results after giving up on waiting.

Extends​

Constructors​

Constructor​

new ProviderBatchError(message, status, requestId, batch?, providerError?, options?): ProviderBatchError

Defined in: packages/core/src/errors.ts:43

Parameters​

message​

string

status​

"cancelled" | "failed" | "expired" | "missing" | "batch-failed" | "unsupported"

requestId​

string

batch?​
id​

string

provider​

string

version​

2

providerError?​
code?​

string

message​

string

statusCode?​

number

type?​

string

options?​
cause?​

unknown

Returns​

ProviderBatchError

Overrides​

BaleybotError.constructor

Properties​

batch?​

readonly optional batch?: object

Defined in: packages/core/src/errors.ts:47

id​

readonly id: string

provider​

readonly provider: string

version​

readonly version: 2

cause?​

optional cause?: unknown

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

BaleybotError.cause

code​

readonly code: string

Defined in: packages/core/src/errors.ts:6

Inherited from​

BaleybotError.code

message​

message: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

BaleybotError.message

name​

name: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

BaleybotError.name

providerError?​

readonly optional providerError?: object

Defined in: packages/core/src/errors.ts:48

code?​

optional code?: string

message​

message: string

statusCode?​

optional statusCode?: number

type?​

optional type?: string

requestId​

readonly requestId: string

Defined in: packages/core/src/errors.ts:46

stack?​

optional stack?: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

BaleybotError.stack

status​

readonly status: "cancelled" | "failed" | "expired" | "missing" | "batch-failed" | "unsupported"

Defined in: packages/core/src/errors.ts:45

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:68

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​

BaleybotError.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:52

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​

BaleybotError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@24.13.3/node_modules/@types/node/globals.d.ts:56

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

BaleybotError.prepareStackTrace