Class: IngestionFailedError

@kortexya/reasoninglayer / IngestionFailedError

Class: IngestionFailedError

Defined in: src/resources/ingestion-session.ts:48

Error thrown when an async ingestion session fails on the backend.

Remarks

Detected during polling when the session status transitions to "failed". session is the session as the engine reported it then, with every document: session.documents[].error gives the reason each failed document failed.

Example

try {
  await handle.waitForSession();
} catch (e) {
  if (e instanceof IngestionFailedError) {
    for (const doc of e.session.documents) {
      if (doc.status === 'failed') console.log(doc.documentId, doc.error);
    }
  }
}

Extends

ReasoningLayerError

Constructors

Constructor

new IngestionFailedError(session): IngestionFailedError

Defined in: src/resources/ingestion-session.ts:60

Parameters

session

IngestionSessionDetailResponse

The failed session, as getSession returned it.

Returns

IngestionFailedError

Overrides

ReasoningLayerError.constructor

Properties

cause?

optional cause?: unknown

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

Inherited from

ReasoningLayerError.cause

message

message: string

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

Inherited from

ReasoningLayerError.message

name

name: string = 'IngestionFailedError'

Defined in: src/resources/ingestion-session.ts:49

Overrides

ReasoningLayerError.name

session

readonly session: IngestionSessionDetailResponse

Defined in: src/resources/ingestion-session.ts:55

The last known session state, with every document and its failure reason.

sessionId

readonly sessionId: string

Defined in: src/resources/ingestion-session.ts:52

The session ID that failed.

stack?

optional stack?: string

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

Inherited from

ReasoningLayerError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@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

ReasoningLayerError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@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

ReasoningLayerError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@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

ReasoningLayerError.prepareStackTrace