Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Class PineconeBatchUpsertError

    An error containing the results of a failed batched document upsert.

    The batches already in flight when the failure surfaced are awaited before this is thrown, so response is a complete account of what landed and what did not — including the documents that were never sent.

    cause is the failure with the lowest batchIndex, which under a maxConcurrency above 1 is not necessarily the rejection that stopped the run. Read response.errors to see every failure.

    import { Errors } from '@pinecone-database/pinecone';

    function reportBatchFailure(error: unknown) {
      if (error instanceof Errors.PineconeBatchUpsertError) {
        console.log(error.response.upsertedCount);
        console.log(error.response.failedItems);
      }
    }

    Hierarchy (View Summary)

    Index
    constructor
    cause? message name response stack? stackTraceLimit
    captureStackTrace prepareStackTrace
    cause?: Error

    The underlying error, if any.

    message: string
    name: string
    response: BatchUpsertDocumentsResponse

    Counts and per-batch failures for the call that threw.

    stack?: string
    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.

    • 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
      • OptionalconstructorOpt: Function

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods