Class: UrlIngestStoreFailedError

@kortexya/reasoninglayer / UrlIngestStoreFailedError

Class: UrlIngestStoreFailedError

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

Error thrown when POST /api/v1/ingest/url crawled, then failed to store its pages part way (HTTP 500, code: 'web_ingest_store_failed').

Remarks

Nothing is rolled back. The pages in report are stored, and its counts cover those pages only. failed names the step and the page that failed, and notWritten lists the pages the crawl read but did not store because the failure came first. A re-run is safe: a page whose content is already stored comes back unchanged.

Extends InternalServerError, so an instanceof InternalServerError check keeps catching it. status is 500; body and headers are those of the engine’s answer, and errorBodyCode reads web_ingest_store_failed.

Example

try {
  await client.ingestion.ingestUrl({ url: 'https://example.org/docs/', maxDepth: 1 });
} catch (e) {
  if (e instanceof UrlIngestStoreFailedError) {
    console.log(`${e.report.created} stored, failed at ${e.failed.step}`);
    console.log(e.notWritten.map((p) => p.url));
  }
}

Extends

InternalServerError

Properties

body

readonly body: unknown

Defined in: src/errors.ts:55

Parsed response body.

Inherited from

InternalServerError.body

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

InternalServerError.cause

errorCode

readonly errorCode: string | undefined

Defined in: src/errors.ts:53

Backend error code (from response body error field), if present.

Inherited from

InternalServerError.errorCode

failed

readonly failed: WebIngestStoreFailure

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

The step that failed, its page (when it had one) and the cause.

headers

readonly headers: Headers

Defined in: src/errors.ts:57

Response headers.

Inherited from

InternalServerError.headers

message

message: string

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

Inherited from

InternalServerError.message

name

name: string = 'UrlIngestStoreFailedError'

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

Overrides

InternalServerError.name

notWritten

readonly notWritten: readonly WebPageRef[]

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

Pages read but not stored, in crawl order. The failed page is in failed.

report

readonly report: IngestUrlResponse

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

The pages stored before the failure, as a 200 would report them.

stack?

optional stack?: string

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

Inherited from

InternalServerError.stack

status

readonly status: number

Defined in: src/errors.ts:51

HTTP status code.

Inherited from

InternalServerError.status

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

InternalServerError.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

InternalServerError.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

InternalServerError.prepareStackTrace